﻿#region The MIT License (MIT)
// The MIT License (MIT)
// Copyright (c) 2010 - 2013 Sovacode LLC
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy of this
// software and associated 
// documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in all copies or substantial portions
// of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
// BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
#endregion

using System;
using Sovacode.RubiksCube.Common.Base;

namespace Sovacode.RubiksCube.Common.Service.Progress
{
    /// <summary>
    /// Interface IProgressService
    /// </summary>
    public interface IProgressService : INotifyValidatedObject
    {
        /// <summary>
        /// Gets the name of the current work.
        /// </summary>
        /// <value>The name of the current work.</value>
        string CurrentWorkName { get; }

        /// <summary>
        /// Gets a value indicating whether this <see cref="IProgressService"/> is working.
        /// </summary>
        /// <value><c>true</c> if working; otherwise, <c>false</c>.</value>
        bool Working { get; }

        /// <summary>
        /// Starts the work.
        /// </summary>
        /// <param name="work">The work.</param>
        /// <param name="onCompleted">The configuration completed.</param>
        /// <param name="workName">Name of the work.</param>
        void StartWork(Action work, Action onCompleted = null, string workName = "");

        /// <summary>
        /// Starts the work.
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="work">The work.</param>
        /// <param name="onCompleted">The configuration completed.</param>
        /// <param name="workName">Name of the work.</param>
        void StartWork<T>(Func<T> work, Action<T> onCompleted = null, string workName = "");
    }
}